// Go作者版权所有。版权所有。
// 此源代码的使用受BSD样式的约束
// 可以在许可证文件中找到的许可证。

// 包cfg保存由多个部件共享的配置
// go命令的一部分。
package cfg

import (
	"bytes"
	"fmt"
	"go/build"
	"internal/buildcfg"
	"internal/cfg"
	"io"
	"os"
	"path/filepath"
	"runtime"
	"strings"
	"sync"

	"cmd/go/internal/fsys"
)

// 这些是build和其他命令使用的通用“build标志”。
var (
	BuildA                 bool   // -旗帜
	BuildBuildmode         string // -构建模式标志
	BuildContext           = defaultContext()
	BuildMod               string                  // -mod标志
	BuildModExplicit       bool                    // 是否显式设置了-mod
	BuildModReason         string                  // 原因-如果默认设置，则设置了mod
	BuildI                 bool                    // -我旗
	BuildLinkshared        bool                    // -链接共享标志
	BuildMSan              bool                    // -msan旗
	BuildN                 bool                    // -n旗
	BuildO                 string                  // -o旗
	BuildP                 = runtime.GOMAXPROCS(0) // -p旗
	BuildPkgdir            string                  // -pkgdir标志
	BuildRace              bool                    // -比赛旗
	BuildToolexec          []string                // -toolexec标志
	BuildToolchainName     string
	BuildToolchainCompiler func() string
	BuildToolchainLinker   func() string
	BuildTrimpath          bool // -trimpath标志
	BuildV                 bool // -v旗
	BuildWork              bool // -工作旗
	BuildX                 bool // -x旗

	ModCacheRW bool   // -modcacherw标志
	ModFile    string // -modfile标志

	CmdName string // “构建”、“安装”、“列表”、“修改”等。

	DebugActiongraph string // -调试动作图标志（未记录，不稳定）
	DebugTrace       string // -调试跟踪标志
)

func defaultContext() build.Context {
	ctxt := build.Default
	ctxt.JoinPath = filepath.Join // 后门说“不要使用go命令”

	ctxt.GOROOT = findGOROOT()
	if runtime.Compiler != "gccgo" {
		// 注意，这里必须使用runtime.GOOS和runtime.GOARCH，
		// 因为工具目录不会根据环境移动
		// 变量。这与中ToolDir的初始化相匹配
		// go/build，除了使用ctxt.GOROOT而不是
		// runtime.GOROOT。
		build.ToolDir = filepath.Join(ctxt.GOROOT, "pkg/tool/"+runtime.GOOS+"_"+runtime.GOARCH)
	}

	ctxt.GOPATH = envOr("GOPATH", ctxt.GOPATH)

	// 使用默认值覆盖go/build中计算的默认值
	// 来自go环境配置文件（如果已知）。
	ctxt.GOOS = envOr("GOOS", ctxt.GOOS)
	ctxt.GOARCH = envOr("GOARCH", ctxt.GOARCH)

	// 实验标志基于目标，因此可能
	// 需要改变。TODO:这个应该清理一下。
	buildcfg.UpdateExperiments(ctxt.GOOS, ctxt.GOARCH, envOr("GOEXPERIMENT", buildcfg.DefaultGOEXPERIMENT))
	ctxt.ToolTags = nil
	for _, exp := range buildcfg.EnabledExperiments() {
		ctxt.ToolTags = append(ctxt.ToolTags, "goexperiment."+exp)
	}

	// 是否启用cgo的go/build规则为：
	// 1.如果设置了$CGO_ENABLED，请尊重它。
	// 2.否则，如果这是交叉编译，请禁用cgo。
	// 3.否则，对GOOS/GOARCH使用内置默认值。
	// 使用新的GOOS/GOARCH设置在此处重新创建该逻辑。
	if v := Getenv("CGO_ENABLED"); v == "0" || v == "1" {
		ctxt.CgoEnabled = v[0] == '1'
	} else if ctxt.GOOS != runtime.GOOS || ctxt.GOARCH != runtime.GOARCH {
		ctxt.CgoEnabled = false
	} else {
		// 使用GOOS/GOARCH的内置默认cgo设置。
		// 请注意，ctxt.GOOS/GOARCH是从首选项列表派生的
		// （1） 环境，（2）go/env文件，（3）运行时常量，
		// 而go/build.Default.GOOS/GOARCH是从首选项列表派生的
		// （1） 环境，（2）运行时常量。
		// 我们知道ctxt.GOOS/GOARCH==runtime.GOOS/GOARCH；
		// 无论发生什么情况，go/build.Default都会使
		// 相同的决策（明确设置环境变量或
		// 要匹配运行时常量，或者它们未设置，其中
		// case go/build返回到运行时常量），因此
		// go/build.Default.GOOS/GOARCH==runtime.GOOS/GOARCH。
		// 因此ctxt.CgoEnabled（=go/build.Default.CgoEnabled）是正确的
		// 原样，可以不修改。
		// 这里没什么可做的。
	}

	ctxt.OpenFile = func(path string) (io.ReadCloser, error) {
		return fsys.Open(path)
	}
	ctxt.ReadDir = fsys.ReadDir
	ctxt.IsDir = func(path string) bool {
		isDir, err := fsys.IsDir(path)
		return err == nil && isDir
	}

	return ctxt
}

func init() {
	BuildToolchainCompiler = func() string { return "missing-compiler" }
	BuildToolchainLinker = func() string { return "missing-linker" }
}

// EnvVar是一个环境变量Name=Value。
type EnvVar struct {
	Name  string
	Value string
}

// OrigEnv是程序启动时的原始环境。
var OrigEnv []string

// CmdEnv是运行go tool命令的新环境。
// 用户二进制文件（在go测试或go运行期间）使用OrigEnv运行，
// 不是CmdEnv。
var CmdEnv []EnvVar

// 全局生成参数（在包加载期间使用）
var (
	Goarch = BuildContext.GOARCH
	Goos   = BuildContext.GOOS

	ExeSuffix = exeSuffix()

	// ModuleEnabled指定go命令是否正在运行
	// 在模块感知模式下（与GOPATH模式相反）。
	// 它等于modload.Enabled，但并非所有包都可以导入modload。
	ModulesEnabled bool
)

func exeSuffix() string {
	if Goos == "windows" {
		return ".exe"
	}
	return ""
}

var envCache struct {
	once sync.Once
	m    map[string]string
}

// EnvFile返回Go环境配置文件的名称。
func EnvFile() (string, error) {
	if file := os.Getenv("GOENV"); file != "" {
		if file == "off" {
			return "", fmt.Errorf("GOENV=off")
		}
		return file, nil
	}
	dir, err := os.UserConfigDir()
	if err != nil {
		return "", err
	}
	if dir == "" {
		return "", fmt.Errorf("missing user-config dir")
	}
	return filepath.Join(dir, "go/env"), nil
}

func initEnvCache() {
	envCache.m = make(map[string]string)
	file, _ := EnvFile()
	if file == "" {
		return
	}
	data, err := os.ReadFile(file)
	if err != nil {
		return
	}

	for len(data) > 0 {
		// 接下一行。
		line := data
		i := bytes.IndexByte(data, '\n')
		if i >= 0 {
			line, data = line[:i], data[i+1:]
		} else {
			data = nil
		}

		i = bytes.IndexByte(line, '=')
		if i < 0 || line[0] < 'A' || 'Z' < line[0] {
			// 行缺少=（或空）或注释或不是有效的环境名称。忽视
			// （这种情况不应该发生，因为文件几乎都需要维护。）
			// 由“go env-w”独家发布，但最好是默默地忽略，而不是制造
			// go命令无法使用，只是因为env文件已
			// 腐败了。）
			continue
		}
		key, val := line[:i], line[i+1:]
		envCache.m[string(key)] = string(val)
	}
}

// Getenv获取配置键的值。
// 它参考操作系统环境
// 然后是go/env文件。
// 如果为无法设置的键调用Getenv
// 在go/env文件（例如GODEBUG）中，它会崩溃。
// 这确保了CanGetenv的准确性，以便
// “go env-w”与Getenv可以检索的内容保持同步。
func Getenv(key string) string {
	if !CanGetenv(key) {
		switch key {
		case "CGO_TEST_ALLOW", "CGO_TEST_DISALLOW", "CGO_test_ALLOW", "CGO_test_DISALLOW":
			// 由内部/工作/安全_test.go使用；允许
		default:
			panic("internal error: invalid Getenv " + key)
		}
	}
	val := os.Getenv(key)
	if val != "" {
		return val
	}
	envCache.once.Do(initEnvCache)
	return envCache.m[key]
}

// CanGetenv报告密钥是否为有效的go/env配置密钥。
func CanGetenv(key string) bool {
	return strings.Contains(cfg.KnownEnv, "\t"+key+"\n")
}

var (
	GOROOT       = BuildContext.GOROOT
	GOBIN        = Getenv("GOBIN")
	GOROOTbin    = filepath.Join(GOROOT, "bin")
	GOROOTpkg    = filepath.Join(GOROOT, "pkg")
	GOROOTsrc    = filepath.Join(GOROOT, "src")
	GOROOT_FINAL = findGOROOT_FINAL()
	GOMODCACHE   = envOr("GOMODCACHE", gopathDir("pkg/mod"))

	// 用于envmd.MkEnv和生成ID计算。
	GOARM    = envOr("GOARM", fmt.Sprint(buildcfg.GOARM))
	GO386    = envOr("GO386", buildcfg.GO386)
	GOMIPS   = envOr("GOMIPS", buildcfg.GOMIPS)
	GOMIPS64 = envOr("GOMIPS64", buildcfg.GOMIPS64)
	GOPPC64  = envOr("GOPPC64", fmt.Sprintf("%s%d", "power", buildcfg.GOPPC64))
	GOWASM   = envOr("GOWASM", fmt.Sprint(buildcfg.GOWASM))

	GOPROXY    = envOr("GOPROXY", "https:// proxy.golang.org，direct”）
	GOSUMDB    = envOr("GOSUMDB", "sum.golang.org")
	GOPRIVATE  = Getenv("GOPRIVATE")
	GONOPROXY  = envOr("GONOPROXY", GOPRIVATE)
	GONOSUMDB  = envOr("GONOSUMDB", GOPRIVATE)
	GOINSECURE = Getenv("GOINSECURE")
	GOVCS      = Getenv("GOVCS")
)

var SumdbDir = gopathDir("pkg/sumdb")

// GetArchEnv返回
// 特定于目标的体系结构环境变量。
// 如果当前架构没有特定于目标的变量，
// GetArchEnv返回空键和值。
func GetArchEnv() (key, val string) {
	switch Goarch {
	case "arm":
		return "GOARM", GOARM
	case "386":
		return "GO386", GO386
	case "mips", "mipsle":
		return "GOMIPS", GOMIPS
	case "mips64", "mips64le":
		return "GOMIPS64", GOMIPS64
	case "ppc64", "ppc64le":
		return "GOPPC64", GOPPC64
	case "wasm":
		return "GOWASM", GOWASM
	}
	return "", ""
}

// 如果设置了，envOr返回Getenv（键），否则返回def。
func envOr(key, def string) string {
	val := Getenv(key)
	if val == "" {
		val = def
	}
	return val
}

// 中有findGOROOT、isSameDir和isGOROOT的副本
// x/tools/cmd/godoc/goroot.go。
// 现在就试着让它们保持同步。

// findGOROOT使用显式
// 提供的环境变量，包含当前
// 可执行值，或者生成二进制文件的GOROOT
// 使用from runtime.GOROOT（）。
// None
// 在x/tools/cmd/godoc/goroot.go中有此代码的副本。
func findGOROOT() string {
	if env := Getenv("GOROOT"); env != "" {
		return filepath.Clean(env)
	}
	def := filepath.Clean(runtime.GOROOT())
	if runtime.Compiler == "gccgo" {
		// gccgo没有真正的GOROOT，当然也没有
		// 取决于可执行文件的位置。
		return def
	}
	exe, err := os.Executable()
	if err == nil {
		exe, err = filepath.Abs(exe)
		if err == nil {
			if dir := filepath.Join(exe, "../.."); isGOROOT(dir) {
				// 如果def（runtime.GOROOT（））和dir相同
				// 目录，首选def中使用的拼写。
				if isSameDir(def, dir) {
					return def
				}
				return dir
			}
			exe, err = filepath.EvalSymlinks(exe)
			if err == nil {
				if dir := filepath.Join(exe, "../.."); isGOROOT(dir) {
					if isSameDir(def, dir) {
						return def
					}
					return dir
				}
			}
		}
	}
	return def
}

func findGOROOT_FINAL() string {
	// $GOROOT_FINAL仅在make.bash期间使用
	// 所以它不能使用go/env设置，所以我们在这里使用os.Getenv。
	def := GOROOT
	if env := os.Getenv("GOROOT_FINAL"); env != "" {
		def = filepath.Clean(env)
	}
	return def
}

// isSameDir报告dir1和dir2是否为同一目录。
func isSameDir(dir1, dir2 string) bool {
	if dir1 == dir2 {
		return true
	}
	info1, err1 := os.Stat(dir1)
	info2, err2 := os.Stat(dir2)
	return err1 == nil && err2 == nil && os.SameFile(info1, info2)
}

// isGOROOT报告路径是否看起来像GOROOT。
// None
// 它通过查找路径/pkg/tool目录来实现这一点，
// 这是有效操作cmd/go工具所必需的，
// 并且通常不存在于GOPATH中。
// None
// 在x/tools/cmd/godoc/goroot.go中有此代码的副本。
func isGOROOT(path string) bool {
	stat, err := os.Stat(filepath.Join(path, "pkg", "tool"))
	if err != nil {
		return false
	}
	return stat.IsDir()
}

func gopathDir(rel string) string {
	list := filepath.SplitList(BuildContext.GOPATH)
	if len(list) == 0 || list[0] == "" {
		return ""
	}
	return filepath.Join(list[0], rel)
}
